Skip to content

docs: RTD hygiene — fix nnumpydoc typo, prune conf.py, add docs CI#597

Merged
Jammy2211 merged 2 commits into
mainfrom
feature/rtd-hygiene
Jul 9, 2026
Merged

docs: RTD hygiene — fix nnumpydoc typo, prune conf.py, add docs CI#597
Jammy2211 merged 2 commits into
mainfrom
feature/rtd-hygiene

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Summary

Phase A of the docs-infrastructure census (PyAutoLabs/PyAutoFit#1341): fixes the nnumpydoc_class_members_toctree typo in docs/conf.py (the setting was silently ignored; True is numpydoc's default so rendering is unchanged — the intent is now explicit), removes the dead html_context block (never read by Furo), drops html_static_path/html_css_files pointing at a pied-piper-admonition.css that never existed in the repo's history (removes a real build warning), extends .gitignore with docs/api/_autosummary, and adds a docs CI check as a thin caller into PyAutoHeart's new reusable docs-build.yml (PyAutoHeart#48), gated on warning-count regression against docs/sphinx_warning_baseline.txt (134).

Merge order: PyAutoHeart#48 merges first — the docs check here errors with "workflow not found" until it lands.

API Changes

None — docs/CI configuration only.

Test Plan

  • PyAutoLens suite: 373 passed (full, worktree)
  • Sphinx before/after: 135 → 134 warnings; the only delta is the removed phantom-_static warning; rendered pages text-identical
  • After PyAutoHeart#48 merges: docs check green on this PR (baseline measured locally; one-time CI recalibration allowed with justification)

Validation checklist (--auto run)

  • Effective level: supervised (header: supervised, cap: docs ≤ medium → safe)
  • Plan: on the issue (docs: RTD hygiene — reconnect PyAutoFit RTD, converge conf.py, add docs CI PyAutoFit#1341), written at start; disclosed riders: .gitignore artifact, warning-baseline file
  • Gate: tests 373 pass · smoke n/a (docs+CI only, no script surface) · review CLEAN · Heart YELLOW within in-session ack at ship (4 pre-existing reasons listed on #1341)
  • Human: plan sound in hindsight?
  • Human: diff matches plan (no scope creep)?
  • Human: merge, amend, or reject — then log the outcome
Full API Changes (for automation & release notes)

None — files touched: docs/conf.py, .gitignore, .github/workflows/docs.yml (new), docs/sphinx_warning_baseline.txt (new).

🤖 Generated with Claude Code

https://claude.ai/code/session_01GziFkivBHz1d11eFYUszmy

Phase A of the docs-infrastructure census (PyAutoLabs/PyAutoFit#1341):
- docs/conf.py: fix the nnumpydoc_class_members_toctree typo (setting was
  silently ignored; True is numpydoc's default, so rendering is unchanged —
  the intent is now explicit); remove the dead html_context block (never
  read by Furo); drop html_static_path/html_css_files pointing at a
  pied-piper-admonition.css that never existed in history (removes the
  html_static_path build warning)
- add .github/workflows/docs.yml — thin caller into PyAutoHeart's reusable
  docs-build workflow; fails on Sphinx warning-count regression against
  docs/sphinx_warning_baseline.txt (currently 134)
- .gitignore: also ignore docs/api/_autosummary

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GziFkivBHz1d11eFYUszmy
@Jammy2211 Jammy2211 merged commit 6a05f4f into main Jul 9, 2026
5 checks passed
@Jammy2211 Jammy2211 deleted the feature/rtd-hygiene branch July 9, 2026 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pending-release PR queued for the next release build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant